<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>tf::cudaStream class | Taskflow QuickStart</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon.ico" type="image/vnd.microsoft.icon" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">QuickStart</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Handbook</a></li>
            <li><a href="namespaces.html">Namespaces</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacetf.html">tf</a>::<wbr/></span>cudaStream <span class="m-thin">class</span>
        </h1>
        <p>class to create an RAII-styled wrapper over a native CUDA stream</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>A <a href="classtf_1_1cudaStream.html" class="m-doc">cudaStream</a> object is an RAII-styled wrapper over a native CUDA stream (<code>cudaStream_t</code>). A <a href="classtf_1_1cudaStream.html" class="m-doc">cudaStream</a> object is move-only.</p>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#ab29390d447e334d4945caf78b24d6ca6" class="m-doc">cudaStream</a>(</span><span class="m-doc-wrap">cudaStream_t stream) <span class="m-label m-flat m-info">explicit</span> </span>
            </dt>
            <dd>constructs an RAII-styled object from the given CUDA stream</dd>
            <dt id="a922ed633cf0670b22aca1430e7a810b1">
              <span class="m-doc-wrap-bumper"><a href="#a922ed633cf0670b22aca1430e7a810b1" class="m-doc-self">cudaStream</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span></span>
            </dt>
            <dd>default constructor</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a1a81d6005e8d60ad082dba2303a8aa30" class="m-doc">synchronize</a>(</span><span class="m-doc-wrap">) const</span>
            </dt>
            <dd>synchronizes the associated stream</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ad98a025ff4306aa799e664a1e2aefd2e" class="m-doc">begin_capture</a>(</span><span class="m-doc-wrap">cudaStreamCaptureMode m = cudaStreamCaptureModeGlobal) const</span>
            </dt>
            <dd>begins graph capturing on the stream</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a9c48388031655cc691b267de96516a66" class="m-doc">end_capture</a>(</span><span class="m-doc-wrap">) const -&gt; cudaGraph_t</span>
            </dt>
            <dd>ends graph capturing on the stream</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a8343c234b4a3040b59626dc70e81d767" class="m-doc">record</a>(</span><span class="m-doc-wrap">cudaEvent_t event) const</span>
            </dt>
            <dd>records an event on the stream</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a6bb195945f7a580bec6105691c53c699" class="m-doc">wait</a>(</span><span class="m-doc-wrap">cudaEvent_t event) const</span>
            </dt>
            <dd>waits on an event</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="ab29390d447e334d4945caf78b24d6ca6"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> tf::<wbr />cudaStream::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab29390d447e334d4945caf78b24d6ca6" class="m-doc-self">cudaStream</a>(</span><span class="m-doc-wrap">cudaStream_t stream) <span class="m-label m-info">explicit</span> </span></span>
            </h3>
            <p>constructs an RAII-styled object from the given CUDA stream</p>
<p>Constructs a <a href="classtf_1_1cudaStream.html" class="m-doc">cudaStream</a> object which owns <code>stream</code>.</p>
          </div></section>
          <section class="m-doc-details" id="a1a81d6005e8d60ad082dba2303a8aa30"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void tf::<wbr />cudaStream::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a1a81d6005e8d60ad082dba2303a8aa30" class="m-doc-self">synchronize</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>synchronizes the associated stream</p>
<p>Equivalently calling <code>cudaStreamSynchronize</code> to block until this stream has completed all operations.</p>
          </div></section>
          <section class="m-doc-details" id="ad98a025ff4306aa799e664a1e2aefd2e"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void tf::<wbr />cudaStream::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad98a025ff4306aa799e664a1e2aefd2e" class="m-doc-self">begin_capture</a>(</span><span class="m-doc-wrap">cudaStreamCaptureMode m = cudaStreamCaptureModeGlobal) const</span></span>
            </h3>
            <p>begins graph capturing on the stream</p>
<p>When a stream is in capture mode, all operations pushed into the stream will not be executed, but will instead be captured into a graph, which will be returned via <a href="classtf_1_1cudaStream.html#a9c48388031655cc691b267de96516a66" class="m-doc">cudaStream::<wbr />end_capture</a>.</p><p>A thread&#x27;s mode can be one of the following:</p><ul><li><code>cudaStreamCaptureModeGlobal:</code> This is the default mode. If the local thread has an ongoing capture sequence that was not initiated with <code>cudaStreamCaptureModeRelaxed</code> at <code>cuStreamBeginCapture</code>, or if any other thread has a concurrent capture sequence initiated with <code>cudaStreamCaptureModeGlobal</code>, this thread is prohibited from potentially unsafe API calls.</li><li><code>cudaStreamCaptureModeThreadLocal:</code> If the local thread has an ongoing capture sequence not initiated with <code>cudaStreamCaptureModeRelaxed</code>, it is prohibited from potentially unsafe API calls. Concurrent capture sequences in other threads are ignored.</li><li><code>cudaStreamCaptureModeRelaxed:</code> The local thread is not prohibited from potentially unsafe API calls. Note that the thread is still prohibited from API calls which necessarily conflict with stream capture, for example, attempting <code>cudaEventQuery</code> on an event that was last recorded inside a capture sequence.</li></ul>
          </div></section>
          <section class="m-doc-details" id="a9c48388031655cc691b267de96516a66"><div>
            <h3>
              <span class="m-doc-wrap-bumper">cudaGraph_t tf::<wbr />cudaStream::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a9c48388031655cc691b267de96516a66" class="m-doc-self">end_capture</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>ends graph capturing on the stream</p>
<p>Equivalently calling <code>cudaStreamEndCapture</code> to end capture on stream and returning the captured graph. Capture must have been initiated on stream via a call to <a href="classtf_1_1cudaStream.html#ad98a025ff4306aa799e664a1e2aefd2e" class="m-doc">cudaStream::<wbr />begin_capture</a>. If capture was invalidated, due to a violation of the rules of stream capture, then a NULL graph will be returned.</p>
          </div></section>
          <section class="m-doc-details" id="a8343c234b4a3040b59626dc70e81d767"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void tf::<wbr />cudaStream::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8343c234b4a3040b59626dc70e81d767" class="m-doc-self">record</a>(</span><span class="m-doc-wrap">cudaEvent_t event) const</span></span>
            </h3>
            <p>records an event on the stream</p>
<p>Equivalently calling <code>cudaEventRecord</code> to record an event on this stream, both of which must be on the same CUDA context.</p>
          </div></section>
          <section class="m-doc-details" id="a6bb195945f7a580bec6105691c53c699"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void tf::<wbr />cudaStream::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6bb195945f7a580bec6105691c53c699" class="m-doc-self">wait</a>(</span><span class="m-doc-wrap">cudaEvent_t event) const</span></span>
            </h3>
            <p>waits on an event</p>
<p>Equivalently calling <code>cudaStreamWaitEvent</code> to make all future work submitted to stream wait for all work captured in event.</p>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Taskflow handbook is part of the <a href="https://taskflow.github.io">Taskflow project</a>, copyright © <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>, 2018&ndash;2023.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
